<!DOCTYPE html>
<html>
<head>
<title>ProFTPD module mod_ident</title>
</head>

<body bgcolor=white>

<hr>
<center>
<h2><b>ProFTPD module <code>mod_ident</code></b></h2>
</center>
<hr><br>

<p>
<b>RFC1413 Identification Support</b><br>

<p>
The <code>mod_ident</code> module is ProFTPD's module for performing
lookups of authenticated user IDs, as per
<a href="http://www.faqs.org/rfcs/rfc1413..html">RFC 1413</a>.

<p>
This module is contained in the <code>mod_ident.c</code> file for
ProFTPD 1.3.<i>x</i>, and is compiled by default.  See the
<a href="#Installation">installation</a> section for more details.

<p>
The most current version of <code>mod_ident</code> can be found in the
ProFTPD source distribution:
<pre>
  <a href="http://www.proftpd.org/">http://www.proftpd.org/</a>
</pre>

<h2>Directives</h2>
<ul>
  <li><a href="#IdentLookups">IdentLookups</a>
</ul>

<p>
<hr>
<h3><a name="IdentLookups">IdentLookups</a></h3>
<strong>Syntax:</strong> IdentLookups <em>on|off</em><br>
<strong>Default:</strong> IdentLookups on<br>
<strong>Context:</strong> server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code><br>
<strong>Module:</strong> mod_ident<br>
<strong>Compatibility:</strong> 1.3.2rc1

<p>
The <code>IdentLookups</code> directive enables or disables the module's lookup
of an "authenticated" user identity using RFC1413.

<p>
Normally, when a client initially connects to ProFTPD, the
<code>mod_ident</code> will attempt to use the ident protocol (RFC1413) to
identify the remote username.  This behavior can be disabled via this directive:
<pre>
  IdentLookups off
</pre>
<b>Not</b> that this lookup can cause delays (and reports of "slow logins")
when clients connect to ProFTPD.

<p>
<hr>
<h2><a name="Installation">Installation</a></h2>
The <code>mod_ident</code> module is compiled into <code>proftpd</code> by
default.  To build a <code>proftpd</code> which does not include the
<code>mod_ident</code> module, use:
<pre>
  $ ./configure --disable-ident ...
</pre>
Note that the <code>mod_ident</code> module can also be built as a shared
module, rather than be statically linked into <code>proftpd</code>:
<pre>
  $ ./configure --enable-dso --with-shared=mod_ident ...
</pre>

<p>
<b>Logging</b><br>
The <code>mod_ident</code> module supports <a href="../howto/Tracing.html">trace logging</a>, via the module-specific log channels:
<ul>
  <li>ident
</ul>
Thus for trace logging, to aid in debugging, you would use the following in
your <code>proftpd.conf</code>:
<pre>
  TraceLog /path/to/ftpd/trace.log
  Trace ident:20
</pre>
This trace logging can generate large files; it is intended for debugging use
only, and should be removed from any production configuration.

<p>
<hr>
<font size=2><b><i>
&copy; Copyright 2008-2016 TJ Saunders<br>
 All Rights Reserved<br>
</i></b></font>
<hr>

</body>
</html>
